Reporting-Reports

[POST] /api/v2/reporting/reports/{reportId}/export/{exportSettingsTemplateId}

使用导出模板导出报表。

参数:

名称	类型	位置	描述
reportId必填项	string	path	报表编号。例如：3a44d8c0-9b3c-4ecf-a934-df08ba87b73e
exportSettingsTemplateId必填项	string	path	导出模板 ID。例如：eb6d614f-e595-4de6-8c51-c54c6b07c295
download	Boolean	query	指示是否应将结果作为可下载文件返回。

请求数据格式

ReportExportRequest

返回值

状态码: 200

成功

ReportExportResponse

状态码: 400

错误的请求

ReportingPluginError

状态码: 403

禁止

ReportingPluginError

状态码: 404

未找到

ReportingPluginError

[POST] /api/v2/reporting/reports/{reportId}/render-info

渲染报表信息。

参数:

名称	类型	位置	描述
reportId必填项	string	path	报表编号。例如：3a44d8c0-9b3c-4ecf-a934-df08ba87b73e

请求数据格式

ReportRenderInfoRequest

返回值

状态码: 200

成功

ReportRenderInfoResponse

状态码: 400

错误的请求

ReportingPluginError

状态码: 403

禁止

ReportingPluginError

状态码: 404

未找到

ReportingPluginError

[POST] /api/v2/reporting/reports/{reportId}/render-parameters-values

渲染报表参数值。

参数:

名称	类型	位置	描述
reportId必填项	string	path	报表编号。例如：3a44d8c0-9b3c-4ecf-a934-df08ba87b73e

请求数据格式

ReportRenderParametersValuesRequest

返回值

状态码: 200

成功

ReportRenderParametersValuesResponse

状态码: 400

错误的请求

ReportingPluginError

状态码: 403

禁止

ReportingPluginError

状态码: 404

未找到

ReportingPluginError

[GET] /api/v2/reporting/reports/{reportId}/download

下载报表。

参数:

名称	类型	位置	描述
reportId必填项	string	path	报表编号。例如：3a44d8c0-9b3c-4ecf-a934-df08ba87b73e

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

ReportingPluginError

状态码: 403

禁止

ReportingPluginError

状态码: 404

未找到

ReportingPluginError

[GET] /api/v2/reporting/reports/{reportId}/embedded/download

下载带有嵌入数据的报表。

参数:

名称	类型	位置	描述
reportId必填项	string	path	报表编号。例如：3a44d8c0-9b3c-4ecf-a934-df08ba87b73e

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

ReportingPluginError

状态码: 403

禁止

ReportingPluginError

状态码: 404

未找到

ReportingPluginError

类型定义

Ƭ ReportExportResponse

报表导出响应模型。

名称	类型	描述
resultUrl可为空	string	结果网址。
resultId可为空	string	结果 ID。
verificationUrl可为空	string	验证网址。
renderingSkipped	Boolean	是否跳过渲染。

Ƭ ReportingPluginError

报表插件错误

名称	类型	描述
code可为空	string	错误代码
message可为空	string	错误信息
context可为空	string	错误上下文

Ƭ ReportExportRequest

报表导出请求模型。

名称	类型	描述	示例
notificationSettings可为空	NotificationSettings	通知设置。
settings可为空	string	渲染扩展的设置。	`{"Title":"Overriden title"}`
overrideExportTemplateSettings	Boolean	是否覆盖导出模板设置。默认值为 false。
interactiveActions可为空	`Array<string>`	交互行为。	`["rpt1/TextBox10/4/toggle","rpt1/TextBox10/5/toggle"]`
skipEmptyReport	Boolean	跳过空报表的渲染。默认值为 false。
maxExecLimit	int32	内部的。最大执行时间。
parameters可为空	`Array`	指定的参数值。	`{"StringParameter":["StringValue"],"Integer":[1],"Boolean":[false],"Date":["2000-01-01T00:00:00.000"]}`
cacheRefreshIsRequired	Boolean	刷新缓存的报表。默认值为 false。
allowedClaims可为空	string	允许的声明列表。	`"full_name,phone_number"`
userFunctions可为空	any	用户函数列表。	`{"CSharp":"","VisualBasic":""}`

Ƭ NotificationSettings

通知设置模型。

名称	类型	描述
channel	NotificationChannel
onSuccess可为空	`Array<string>`	用于通知操作成功的联系人姓名列表。
onFailure可为空	`Array<string>`	用于通知操作失败的联系人姓名列表。

Ƭ NotificationChannel

Enum:

API

Ƭ ReportRenderInfoResponse

报表渲染信息响应模型。

名称	类型	描述
isFPL	Boolean	报表中是否使用固定页面布局。
isSemantic	Boolean	报表是否符合语义。
parameters可为空	ParameterPayload	报表参数列表。
displayType可为空	string	报表显示类型。
sizeType可为空	string	报表尺寸类型。
name可为空	string	报表名称。
parametersView可为空	string	参数视图。
initialId可为空	string	初始 ID。
references可为空	DocumentReference	报表引用的文档。
topParameterPanelHeight可为空	int32	顶部参数面板高度。
meta可为空	string	报表元信息。

Ƭ ParameterPayload

名称	类型	描述	示例
name可为空	string
prompt可为空	string
dataType可为空	string
selectAllValue可为空	any
allowBlank	Boolean
nullable	Boolean
multiValue	Boolean
multiline	Boolean
hidden	Boolean
usedInQuery可为空	string
dependsOn可为空	`Array<string>`
dateOnly	Boolean
displayFormat可为空	string
validValues	ParameterValidValueCollection
defaultValue	ParameterDefaultValueCollection

Ƭ DocumentReference

名称	类型	描述	示例
resourceName可为空	string
resourceDocType可为空	string
documentId可为空	string
documentRev	int32
contentUrl可为空	string

Ƭ ParameterValidValueCollection

名称	类型	描述	示例
dataSet	ParameterValidValueDatasetReference
values可为空	ParameterValidValueDescriptor

Ƭ ParameterDefaultValueCollection

名称	类型	描述	示例
dataSet	ParameterValidValueDatasetReference
values可为空	`Array`

Ƭ ParameterValidValueDatasetReference

名称	类型	描述	示例
dataSetName可为空	string
labelField可为空	string
valueField可为空	string

Ƭ ParameterValidValueDescriptor

名称	类型	描述	示例
label可为空	string
value可为空	any

Ƭ ReportRenderInfoRequest

报表渲染信息请求模型。

名称	类型	描述	示例
skipParameterValues	Boolean	是否跳过处理参数值。默认值为 true。	`true`

Ƭ ReportRenderParametersValuesRequest

报表渲染参数值请求模型。

名称	类型	描述	示例
values可为空	`Array`	指定的参数值。	`{"BooleanParameter":[false],"StringMultiValueParameter":["value1","value2"]}`
request	QueryFields	我们需要检索值的参数名称，有效值。	`{"Parameter1":null}`
allowedClaims可为空	string	允许的声明列表。	`"full_name,phone_number"`